<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<html xmlns="http://www.w3.org/1999/xhtml">
<head>
<meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/>
<meta http-equiv="X-UA-Compatible" content="IE=9"/>
<meta name="generator" content="Doxygen 1.8.13"/>
<meta name="viewport" content="width=device-width, initial-scale=1"/>
<title>OrangeCNC - ARISC firmware documentation: It&#39;s free firmware for the Allwinner H3 SoC&#39;s co-processor (ARISC)</title>
<link href="tabs.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="jquery.js"></script>
<script type="text/javascript" src="dynsections.js"></script>
<link href="navtree.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="resize.js"></script>
<script type="text/javascript" src="navtreedata.js"></script>
<script type="text/javascript" src="navtree.js"></script>
<script type="text/javascript">
  $(document).ready(initResizable);
</script>
<link href="search/search.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="search/searchdata.js"></script>
<script type="text/javascript" src="search/search.js"></script>
<link href="doxygen.css" rel="stylesheet" type="text/css" />
</head>
<body>
<div id="top"><!-- do not remove this div, it is closed by doxygen! -->
<div id="titlearea">
<table cellspacing="0" cellpadding="0">
 <tbody>
 <tr style="height: 56px;">
  <td id="projectalign" style="padding-left: 0.5em;">
   <div id="projectname">OrangeCNC - ARISC firmware documentation
   </div>
  </td>
 </tr>
 </tbody>
</table>
</div>
<!-- end header part -->
<!-- Generated by Doxygen 1.8.13 -->
<script type="text/javascript">
var searchBox = new SearchBox("searchBox", "search",false,'Search');
</script>
<script type="text/javascript" src="menudata.js"></script>
<script type="text/javascript" src="menu.js"></script>
<script type="text/javascript">
$(function() {
  initMenu('',true,false,'search.php','Search');
  $(document).ready(function() { init_search(); });
});
</script>
<div id="main-nav"></div>
</div><!-- top -->
<div id="side-nav" class="ui-resizable side-nav-resizable">
  <div id="nav-tree">
    <div id="nav-tree-contents">
      <div id="nav-sync" class="sync"></div>
    </div>
  </div>
  <div id="splitbar" style="-moz-user-select:none;" 
       class="ui-resizable-handle">
  </div>
</div>
<script type="text/javascript">
$(document).ready(function(){initNavTree('md__r_e_a_d_m_e.html','');});
</script>
<div id="doc-content">
<!-- window showing the filter options -->
<div id="MSearchSelectWindow"
     onmouseover="return searchBox.OnSearchSelectShow()"
     onmouseout="return searchBox.OnSearchSelectHide()"
     onkeydown="return searchBox.OnSearchSelectKey(event)">
</div>

<!-- iframe showing the search results (closed by default) -->
<div id="MSearchResultsWindow">
<iframe src="javascript:void(0)" frameborder="0" 
        name="MSearchResults" id="MSearchResults">
</iframe>
</div>

<div class="header">
  <div class="headertitle">
<div class="title">It's free firmware for the Allwinner H3 SoC's co-processor (ARISC) </div>  </div>
</div><!--header-->
<div class="contents">
<div class="textblock"><ul>
<li>This firmware uses to make a real-time <code>GPIO</code> pulses generation and counting.</li>
<li>This firmware can be used for the any <code>CNC</code> applications - <code>STEP/DIR</code> and <code>PWM</code> generation, <code>ABZ</code> encoders counting.</li>
</ul>
<h2>How to build? </h2>
<ul>
<li>You'll need any <code>Linux OS</code> and a <code>custom toolchain</code>.</li>
<li>Download the toolchain binaries from here - <a href="https://github.com/openrisc/newlib/releases">https://github.com/openrisc/newlib/releases</a></li>
<li>Unpack toolchain binary files into the <code>/opt/toolchains/or1k-elf</code> folder</li>
<li>Clone this repo to any folder: <code>$ git clone <a href="https://github.com/orange-cnc/arisc_firmware.git">https://github.com/orange-cnc/arisc_firmware.git</a></code></li>
<li>Build the firmware by the <code>make all</code> command</li>
</ul>
<h2>How to use? </h2>
<ul>
<li>You'll need any <code>Orange Pi</code> board with <code>Alwinner H3 SoC</code> and any <code>Linux OS</code> built by <code>armbian</code>. SD images can be found here - <a href="https://github.com/orange-cnc/armbian_build/releases,">https://github.com/orange-cnc/armbian_build/releases,</a> and here - <a href="https://www.armbian.com/download/">https://www.armbian.com/download/</a>.</li>
<li>Copy <code>arisc-fw.code</code> binary file and all files from repo's folder <code>/loader</code> into the <code>/boot</code> folder of your <code>Armbian OS</code>.</li>
<li>Restart your <code>Orange Pi</code> board.</li>
<li>Clone arisc linux API repo to any folder of your <code>Armbian OS</code>: <code>$ git clone <a href="https://github.com/orange-cnc/arisc_api.git">https://github.com/orange-cnc/arisc_api.git</a></code></li>
<li>Build arisc linux API by the <code>make all</code> command</li>
<li>Run arisc linux API: <code>$ ./arisc</code> </li>
</ul>
</div></div><!-- contents -->
</div><!-- doc-content -->
<!-- start footer part -->
<div id="nav-path" class="navpath"><!-- id is needed for treeview function! -->
  <ul>
    <li class="footer">Generated by
    <a href="http://www.doxygen.org/index.html">
    <img class="footer" src="doxygen.png" alt="doxygen"/></a> 1.8.13 </li>
  </ul>
</div>
</body>
</html>
